home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 2_queries / who < prev    next >
Text File  |  2001-03-21  |  4KB  |  83 lines
  1. Synopsis:
  2.    who [<switch> [<arg>] [<switch> [<arg>] ...]] [<glob pattern>]
  3.  
  4. Description:
  5.    The WHO command is used to retrieve detailed information about every
  6.    user on irc.  For each user, it returns a single line containing
  7.    their nickname, address (user@hostname), realname (IRCNAME), what
  8.    their current channel is (and whether they have +o or +v there),
  9.    whether they are marked away, and whether they are an irc operator.
  10.  
  11.    The data returned can be filtered by the client in a number of ways.
  12.    It can be set to return only users who are marked away, people with a
  13.    certain username, or users on a specific server.  For large queries,
  14.    the data can also be conveniently dumped to a file for later viewing.
  15.    
  16.    The parameters to -end are as follows:
  17.       $0   name of server queried
  18.       $1   body of the query
  19.  
  20. Options:
  21.    -operators            returns irc operators
  22.    -lusers               returns non-irc operators
  23.    -chops                returns channel operators
  24.    -nick <nickname>      returns info for the given nickname only
  25.    -name <username>      returns info for the given username only
  26.    -host <hostname>      returns info for the given hostname only
  27.    -server <servername>  returns info for the given servername only
  28.    -diagnose             shows contents of the who queue for the server
  29.                          of the current window
  30.    -flush                removes all entries of the who queue for the server
  31.                          of the current window
  32.    -here                 returns users who are not away
  33.    -away                 returns users who are away
  34.    -line {...}           executes {...} for each line of output
  35.    -end {...}            executes {...} at the end of the query
  36.    -file <filename>      compare file contents to each line of output
  37.    -u-i                  show invisible users (opers only, required
  38.                          on the undernet)
  39.  
  40. Examples:
  41.    To list all irc operators on servers from foo.com:
  42.       /who -o -s *.foo.com
  43.  
  44.    To list the channel operators on channel #blah, which you are on:
  45.       /who -c #blah
  46.  
  47.    To list all users from Russia, saving it to a file:
  48.       /who -h *.ru -f ru.users
  49.  
  50.    To list all non-opers and say something at the end:
  51.       /who -lusers -end { echo sheesh. that's alot of lusers! }
  52.  
  53. See Also:
  54.    on(5) who; whois(2)
  55.  
  56. Restrictions:
  57.    There are some limitations to the data returned by WHO.  For instance,
  58.    it will not show users who have user mode +i set, unless that user's
  59.    nickname is explicitly and unambiguously specified.  Similarly, it
  60.    will mask channels with mode +p set, and will not show +s channels at
  61.    all.  These limits do now apply, however, if the user in question is
  62.    on a like channel with the querying client, or if the client is on a
  63.    channel for which data is queried.
  64.  
  65. Other Notes:
  66.    The various command line switches detailed above may be abbreviated,
  67.    as shown in the examples, so line as the abbreviations are unambiguous.
  68.    For instance, -n may not be used, since it matches -nick and -name.
  69.  
  70.    Use of the -file switch is not recommended, unless you know that the WHO
  71.    output will be minimal.  This is because the client reads the entire file
  72.    specified for each line of output, which is obviously quite inefficient,
  73.    to say nothing of being rather abusing to your filesystem.
  74.  
  75.    The arguments from -line are identical to the arguments to on(5) who.
  76.    In fact, -line works exactly like on(5) who. except it ALWAYS overrides
  77.    on(5) who and disappears when the query is done. The -end is similar in
  78.    that it overrides hooks to the 315 numeric.
  79.  
  80.    The -flush switch should *never* be used while a WHO request is still
  81.    pending. The results are unpredictable. This is not a bug.
  82.  
  83.